Rental APIs

Description

A rental contract defines the agreement with the customer for renting units over a period, including pricing, items, and invoice schedule.

Tags and resources

Invoice period

Billing periods defined in a rental contract, used to schedule recurring invoices.

Item

Line items on a rental contract, each representing a rented unit or service.

Quote

A rental quote associated with a rental contract.

Version

Version history of a rental contract, tracking changes to terms and conditions.

GET

rental/contract/{rentalContractId}/shipping-advice-items

List of all shipping advice items which have been forwarded from a specific rental contract

POST

rental/contracts

Creation of new rental contract

GET

rental/contracts

Get list of rental contracts

PUT

rental/contracts/{rentalContractId}

Update rental contract

GET

rental/contracts/{rentalContractId}

Get rental contract details

POST

rental/contracts/{rentalContractId}/api-operations/{apiOperationId}/instances

16 operation(s) for rental/contracts/{rentalContractId}

DELETE

rental/contracts/{rentalContractId}

Delete rental contract

GET

rental/contracts/{rentalContractId}/billing-documents

Lists all sales invoices and creadit notes that were generated for given rental contract

GET

rental/contracts/{rentalContractId}/key-figures?groupBy={groupBy}

Key figures for rental contracts

GET

rental/contracts/contracts-with-placeholders

Lists rental contracts with at least one item which is missing a rental unit allocation

GET

rental/contracts/key-figures?groupBy={groupBy}

Key figures for rental contracts